<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en-us" xml:lang="en-us">
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="DC.Type" content="topic">
  <meta name="DC.Title" content="Preparing for Backup">
  <meta name="product" content="">
  <meta name="DC.Relation" scheme="URI" content="en-us_topic_0000002164825702.html">
  <meta name="prodname" content="">
  <meta name="version" content="">
  <meta name="brand" content="">
  <meta name="DC.Publisher" content="20250306">
  <meta name="prodname" content="csbs">
  <meta name="documenttype" content="usermanual">
  <meta name="DC.Format" content="XHTML">
  <meta name="DC.Identifier" content="EN-US_TOPIC_0000002164665978">
  <meta name="DC.Language" content="en-us">
  <link rel="stylesheet" type="text/css" href="public_sys-resources/commonltr.css">
  <title>Preparing for Backup</title>
 </head>
 <body style="clear:both; padding-left:10px; padding-top:5px; padding-right:5px; padding-bottom:5px">
  <a name="EN-US_TOPIC_0000002164665978"></a><a name="EN-US_TOPIC_0000002164665978"></a>
  <h1 class="topictitle1">Preparing for Backup</h1>
  <div>
   <p>Before backing up the ClickHouse, prepare related information as follows:</p>
   <ul>
    <li><a href="#EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table481544017344">Table 1</a> lists the required information.</li>
    <li><a href="#EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table163117288184">Table 2</a> lists the information required when the authentication mode for communication between the ClickHouse cluster and <span>product</span> is <span class="parmvalue"><b>Database authentication</b></span>.</li>
    <li><a href="#EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table8758104318915">Table 3</a> lists the information required when the authentication mode for communication between the ClickHouse cluster and <span>product</span> is <span class="parmvalue"><b>Kerberos authentication</b></span>.</li>
   </ul>
   <div class="tablenoborder">
    <a name="EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table481544017344"></a><a name="en-us_topic_0000001514245969_table481544017344"></a>
    <table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table481544017344" frame="border" border="1" rules="all">
     <caption>
      <b>Table 1 </b>Preparations for backup
     </caption>
     <colgroup>
      <col style="width:18.310000000000002%">
      <col style="width:14.62%">
      <col style="width:50.73%">
      <col style="width:16.34%">
     </colgroup>
     <thead align="left">
      <tr>
       <th align="left" class="cellrowborder" valign="top" width="18.310000000000002%" id="mcps1.3.3.2.5.1.1"><p>Item</p></th>
       <th align="left" class="cellrowborder" valign="top" width="14.62%" id="mcps1.3.3.2.5.1.2"><p>Mandatory</p></th>
       <th align="left" class="cellrowborder" valign="top" width="50.73%" id="mcps1.3.3.2.5.1.3"><p>How to Obtain</p></th>
       <th align="left" class="cellrowborder" valign="top" width="16.34%" id="mcps1.3.3.2.5.1.4"><p>Section</p></th>
      </tr>
     </thead>
     <tbody>
      <tr>
       <td class="cellrowborder" valign="top" width="18.310000000000002%" headers="mcps1.3.3.2.5.1.1 "><p>Installation path of the ClickHouse application in the production environment</p></td>
       <td class="cellrowborder" valign="top" width="14.62%" headers="mcps1.3.3.2.5.1.2 "><p>Yes</p></td>
       <td class="cellrowborder" valign="top" width="50.73%" headers="mcps1.3.3.2.5.1.3 "><p>Obtain the item from the MRS cluster administrator.</p></td>
       <td class="cellrowborder" rowspan="4" valign="top" width="16.34%" headers="mcps1.3.3.2.5.1.4 "><p><a href="en-us_topic_0000002200152273.html">Step 1: Registering a ClickHouse Cluster</a></p> <p></p> <p></p> <p></p> <p></p></td>
      </tr>
      <tr>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.1 "><p>ClickHouse service IP address</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.2 "><p>Yes</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.3 "><p>Obtain the item from the MRS cluster administrator.</p></td>
      </tr>
      <tr>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.1 "><p>Port for the client to connect to the ClickHouse server through TCP SSL</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.2 "><p>Yes</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.3 "><p>Obtain the item from the MRS cluster administrator.</p> <p>Set the port for the client to connect to the ClickHouse server through TCP SSL. The default value is <strong id="EN-US_TOPIC_0000002164665978__en-us_topic_0000002200152273_b796313193010">21427</strong>. The value ranges from <strong id="EN-US_TOPIC_0000002164665978__en-us_topic_0000002200152273_b157116514291">21420</strong> to <strong id="EN-US_TOPIC_0000002164665978__en-us_topic_0000002200152273_b853955472914">21469</strong>.</p></td>
      </tr>
      <tr>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.1 "><p>Checking whether Kerberos authentication is enabled for the ClickHouse cluster</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.2 "><p>Yes</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.3.2.5.1.3 "><p>Check whether the value of <span class="parmname"><b>hadoop.security.authentication</b></span> in the <strong>core-site.xml</strong> file of the Hadoop cluster is <span class="parmvalue"><b>kerberos</b></span>. If information similar to the following is displayed, Kerberos authentication is enabled.</p> <p><span><img src="en-us_image_0000002164825750.png"></span></p></td>
      </tr>
     </tbody>
    </table>
   </div>
   <div class="tablenoborder">
    <a name="EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table163117288184"></a><a name="en-us_topic_0000001514245969_table163117288184"></a>
    <table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table163117288184" frame="border" border="1" rules="all">
     <caption>
      <b>Table 2 </b>Information required for database authentication
     </caption>
     <colgroup>
      <col style="width:22.220000000000002%">
      <col style="width:10.52%">
      <col style="width:42.26%">
      <col style="width:25%">
     </colgroup>
     <thead align="left">
      <tr>
       <th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.4.2.5.1.1"><p>Item</p></th>
       <th align="left" class="cellrowborder" valign="top" width="10.52%" id="mcps1.3.4.2.5.1.2"><p>Mandatory</p></th>
       <th align="left" class="cellrowborder" valign="top" width="42.26%" id="mcps1.3.4.2.5.1.3"><p>How to Obtain</p></th>
       <th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.5.1.4"><p>Section</p></th>
      </tr>
     </thead>
     <tbody>
      <tr>
       <td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.4.2.5.1.1 "><p>Database user name and password</p></td>
       <td class="cellrowborder" valign="top" width="10.52%" headers="mcps1.3.4.2.5.1.2 "><p>Yes</p></td>
       <td class="cellrowborder" valign="top" width="42.26%" headers="mcps1.3.4.2.5.1.3 "><p>Obtain the item from the MRS cluster administrator.</p>
        <div class="note">
         <span class="notetitle"> NOTE: </span>
         <div class="notebody">
          <p>Enter the name of a user having the read and write permissions on the protected resources.</p>
         </div>
        </div></td>
       <td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.5.1.4 "><p><a href="en-us_topic_0000002200152273.html">Step 1: Registering a ClickHouse Cluster</a></p></td>
      </tr>
     </tbody>
    </table>
   </div>
   <div class="tablenoborder">
    <a name="EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table8758104318915"></a><a name="en-us_topic_0000001514245969_table8758104318915"></a>
    <table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002164665978__en-us_topic_0000001514245969_table8758104318915" frame="border" border="1" rules="all">
     <caption>
      <b>Table 3 </b>Information required for Kerberos authentication
     </caption>
     <colgroup>
      <col style="width:19.41%">
      <col style="width:13.52%">
      <col style="width:50.73%">
      <col style="width:16.34%">
     </colgroup>
     <thead align="left">
      <tr>
       <th align="left" class="cellrowborder" valign="top" width="19.41%" id="mcps1.3.5.2.5.1.1"><p>Item</p></th>
       <th align="left" class="cellrowborder" valign="top" width="13.52%" id="mcps1.3.5.2.5.1.2"><p>Mandatory</p></th>
       <th align="left" class="cellrowborder" valign="top" width="50.73%" id="mcps1.3.5.2.5.1.3"><p>How to Obtain</p></th>
       <th align="left" class="cellrowborder" valign="top" width="16.34%" id="mcps1.3.5.2.5.1.4"><p>Section</p></th>
      </tr>
     </thead>
     <tbody>
      <tr>
       <td class="cellrowborder" valign="top" width="19.41%" headers="mcps1.3.5.2.5.1.1 "><p>Principal name of Kerberos authentication</p></td>
       <td class="cellrowborder" valign="top" width="13.52%" headers="mcps1.3.5.2.5.1.2 "><p>Yes</p></td>
       <td class="cellrowborder" valign="top" width="50.73%" headers="mcps1.3.5.2.5.1.3 "><p>Obtain the principal name from the Kerberos server administrator.</p>
        <div class="note">
         <span class="notetitle"> NOTE: </span>
         <div class="notebody">
          <p id="EN-US_TOPIC_0000002164665978__en-us_topic_0000002200152273_p521253601515">Set this parameter to the human-machine username of the big data platform. The user must have the permission to manage the resources to be accessed.</p>
         </div>
        </div></td>
       <td class="cellrowborder" rowspan="4" valign="top" width="16.34%" headers="mcps1.3.5.2.5.1.4 "><p><a href="en-us_topic_0000002200152273.html">Step 1: Registering a ClickHouse Cluster</a></p> <p></p> <p></p> <p></p> <p></p></td>
      </tr>
      <tr>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.1 "><p><span class="filepath"><b>.conf</b></span> configuration file (for example, <strong>krb5.conf</strong>) used during Kerberos authentication</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.2 "><p>Yes</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.3 "><p>Contact the Kerberos server administrator to obtain the file from the Kerberos server.</p> <p><span id="EN-US_TOPIC_0000002164665978__ph927014510226">Take MRS as an example. For details about how to obtain the configuration file, see "Exporting an Authentication Credential File" in the <a href="https://support.huawei.com/enterprise/en/cloud-computing/mapreduce-service-pid-22396131" target="_blank" rel="noopener noreferrer">MapReduce Service Product Documentation</a> of the corresponding version.</span></p></td>
      </tr>
      <tr>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.1 "><p>Password of the principal name</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.2 "><p>No</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.3 "><p>If Kerberos authentication is performed using a password, you need to obtain the password of the principal name.</p></td>
      </tr>
      <tr>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.1 "><p><strong>.keytab</strong> file</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.2 "><p>No</p></td>
       <td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.3 "><p>If Kerberos authentication is performed using a <strong>keytab</strong> file, you need to obtain the <strong>.keytab</strong> file.</p> <p>Contact the Kerberos server administrator to obtain the file from the Kerberos server.</p> <p><span>Take MRS as an example. For details about how to obtain the configuration file, see "Exporting an Authentication Credential File" in the <a href="https://support.huawei.com/enterprise/en/cloud-computing/mapreduce-service-pid-22396131" target="_blank" rel="noopener noreferrer">MapReduce Service Product Documentation</a> of the corresponding version.</span></p></td>
      </tr>
     </tbody>
    </table>
   </div>
  </div>
  <div>
   <div class="familylinks">
    <div class="parentlink">
     <strong>Parent topic:</strong> <a href="en-us_topic_0000002164825702.html">Backup</a>
    </div>
   </div>
  </div>
 </body>
</html>